kanzi::ClickManipulator Class Reference

Click input manipulator recognizes the click and tap gestures from incoming touch events. More...

#include <kanzi/core.ui/input/click_manipulator.hpp>

Inheritance diagram for kanzi::ClickManipulator:
kanzi::InputManipulator kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Classes

class  ClickBeginMessageArguments
 Message arguments for click gesture began message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  ClickCancelMessageArguments
 Message arguments for click canceled message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  ClickEnterMessageArguments
 Message arguments for pointer entering the node area message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  ClickLeaveMessageArguments
 Message arguments for pointer leaving the node area message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 
class  ClickMessageArguments
 Message arguments for click gesture recognized message. Inherits argument properties from InputManipulator::InputMessageArguments. More...
 

Public Member Functions

void setHoverToBegin (bool hoverToBegin)
 Enable or disable the gesture to begin on pressed touch point arriving to the node area. More...
 
bool isPressed () const
 Returns true if manipulator is in the pressed state. More...
 
- Public Member Functions inherited from kanzi::InputManipulator
virtual ~InputManipulator ()
 Destructor. More...
 
void reset ()
 Reset the manipulator. More...
 
void cancel ()
 Notify manipulator of touch canceling. More...
 
State getState () const
 Get the state of the input manipulator. More...
 
void setState (State state)
 Set the state of the input manipulator. More...
 
NodegetAttachedNode () const
 Gets the node to which the input manipulator is attached. More...
 
void requireToFail (InputManipulatorWeakPtr manipulatorToFail)
 Sets the input manipulator that must fail before Kanzi can recognize this input manipulator. More...
 
InputManipulatorWeakPtr getFailManipulator () const
 Gets the fail manipulator. More...
 
InputManipulatorgetDependManipulator () const
 Gets the dependant input manipulator. More...
 
bool isAttached () const
 Tells whether the input manipulator is attached to a node. More...
 
void setReferenceNode (NodeWeakPtr referenceNode)
 Override the attached node as the hit test reference node. More...
 
void setTouchEventRoutingMode (TouchEventRoutingMode mode)
 Sets the touch event routing mode that you want the input manager to use when distributing the touch points to manipulators. More...
 
TouchEventRoutingMode getTouchEventRoutingMode ()
 Returns the current touch event routing mode. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static ClickManipulatorSharedPtr create (Domain *domain, string_view="")
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

static MessageType< ClickMessageArgumentsClickMessage
 Message type for notifying recognition of click gesture. More...
 
static MessageType< ClickBeginMessageArgumentsClickBeginMessage
 Message type for notifying the beginning of a click gesture. More...
 
static MessageType< ClickCancelMessageArgumentsClickCancelMessage
 Message type for notifying cancellation of click gesture. More...
 
static MessageType< ClickEnterMessageArgumentsClickEnterMessage
 Message type for notifying the tracked touch entering the node area. More...
 
static MessageType< ClickLeaveMessageArgumentsClickLeaveMessage
 Message type for notifying the tracked touch leaving the node area. More...
 

Protected Member Functions

 ClickManipulator (Domain *domain)
 Constructor. More...
 
virtual void notifyTouchInside (const TouchInfo &touchInfo) KZ_OVERRIDE
 InputManipulator::notifyTouchInside implementation. More...
 
virtual void notifyTouchOutside (const TouchInfo &touchInfo) KZ_OVERRIDE
 InputManipulator::notifyTouchOutside implementation. More...
 
virtual void onReset () KZ_OVERRIDE
 InputManipulator::onReset implementation. More...
 
virtual void onFail () KZ_OVERRIDE
 InputManipulator::onFail implementation. More...
 
- Protected Member Functions inherited from kanzi::InputManipulator
 InputManipulator (Domain *domain)
 Constructor. More...
 
virtual void onAttach ()
 Attach function for input manipulators. More...
 
virtual void onDetach ()
 Detach function for input manipulators. More...
 
virtual void onCancel ()
 Cancel function for input manipulators. More...
 
void addHitTestArguments (MessageArguments &message, const KzuInputTouchPoint &touchPoint)
 Add hit test information arguments to the message from the touch point. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 

Additional Inherited Members

- Public Types inherited from kanzi::InputManipulator
enum  State {
  StateReady, StatePossible, StateBegin, StateChange,
  StateEnd, StateFail, StateDelayed, StateCanceled
}
 Enumeration for possible input manipulator states during touch or mouse input sequence. More...
 
enum  TouchEventRoutingMode { RoutingBubbling, RoutingTunneling }
 Enumeration for the available touch event routing modes. More...
 
typedef vector< KzuInputTouchPoint * > TouchPointsContainer
 
typedef TouchPointsContainer::const_iterator TouchPointsConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::InputManipulator
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Click input manipulator recognizes the click and tap gestures from incoming touch events.

It generates the messages required to implement the logic for objects which users can click or tap the object. For example, use the click input manipulator to a create button.

See also
DragAndDropManipulator, LongPressManipulator, MultiClickManipulator, PanManipulator, PinchManipulator

Examples

To receive the click event, add a message handler for the ClickMessage message.

First create a handler method:

void onNodeClicked(ClickManipulator::ClickMessageArguments& /*messageArguments*/)
{
// Insert your code to handle the click event here
}

Then add a message handler for your node:

node->addInputManipulator(clickManipulator);
clickMessageSubscription = node->addMessageHandler(ClickManipulator::ClickMessage, bind(&InputManipulatorSnippet::onNodeClicked, this, placeholders::_1));

To configure the click manipulator to work together with the multi-click manipulator, you need to configure the click manipulator to wait for the failure of the multi-click:

node->addInputManipulator(clickManipulator);
MultiClickManipulatorSharedPtr doubleClickManipulator =
node->addInputManipulator(doubleClickManipulator);
doubleClickManipulator->setExpectedClicks(2);
MultiClickManipulatorSharedPtr tripleClickManipulator =
tripleClickManipulator->setExpectedClicks(3);
node->addInputManipulator(tripleClickManipulator);
// Configure the click manipulator to wait for the failure of the double-click manipulator.
clickManipulator->requireToFail(doubleClickManipulator);
// Configure the double-click manipulator to wait for the failure of the triple-click manipulator
doubleClickManipulator->requireToFail(tripleClickManipulator);

Constructor & Destructor Documentation

kanzi::ClickManipulator::ClickManipulator ( Domain domain)
explicitprotected

Constructor.

Member Function Documentation

static ClickManipulatorSharedPtr kanzi::ClickManipulator::create ( Domain domain,
string_view  = "" 
)
inlinestatic
void kanzi::ClickManipulator::setHoverToBegin ( bool  hoverToBegin)

Enable or disable the gesture to begin on pressed touch point arriving to the node area.

bool kanzi::ClickManipulator::isPressed ( ) const

Returns true if manipulator is in the pressed state.

virtual void kanzi::ClickManipulator::notifyTouchInside ( const TouchInfo touchInfo)
protectedvirtual

InputManipulator::notifyTouchInside implementation.

Reimplemented from kanzi::InputManipulator.

virtual void kanzi::ClickManipulator::notifyTouchOutside ( const TouchInfo touchInfo)
protectedvirtual
virtual void kanzi::ClickManipulator::onReset ( )
protectedvirtual

InputManipulator::onReset implementation.

Reimplemented from kanzi::InputManipulator.

virtual void kanzi::ClickManipulator::onFail ( )
protectedvirtual

InputManipulator::onFail implementation.

Reimplemented from kanzi::InputManipulator.

Member Data Documentation

MessageType<ClickMessageArguments> kanzi::ClickManipulator::ClickMessage
static

Message type for notifying recognition of click gesture.

Click message is generated when the tracked touch is released over the attached node or when the fail manipulator fails (see InputManipulator::requireToFail).

MessageType<ClickBeginMessageArguments> kanzi::ClickManipulator::ClickBeginMessage
static

Message type for notifying the beginning of a click gesture.

There are two scenarios for ClickBeginMessage to be generated: 1) When touch is pressed over the attached node. This is the default behavior. 2) If the gesture is set to start on hover with the setHoverToBegin function, click gesture begins when the touch arrives in the node area while being pressed.

MessageType<ClickCancelMessageArguments> kanzi::ClickManipulator::ClickCancelMessage
static

Message type for notifying cancellation of click gesture.

Click gesture is canceled when the tracked touch is released outside the node area, or when the fail manipulator succeeds (see InputManipulator::requireToFail).

MessageType<ClickEnterMessageArguments> kanzi::ClickManipulator::ClickEnterMessage
static

Message type for notifying the tracked touch entering the node area.

Click enter message is generated when touch is pressed over the node area or when the touch returns to the node area after leaving it.

MessageType<ClickLeaveMessageArguments> kanzi::ClickManipulator::ClickLeaveMessage
static

Message type for notifying the tracked touch leaving the node area.

Click leave message is generated when the pointer leaves the area or when the click gesture is completed or canceled.


The documentation for this class was generated from the following file: